Custom fe docs fix #800
Custom fe docs fix #800
Conversation
PetrNovota
left a comment
PetrNovota
left a comment
There was a problem hiding this comment.
Please, polish out a couple of minor details and it will be ready.
custom-frontend/GETTING_STARTED.md
Outdated
|
|
||
| ### Install dependencies | ||
| - Node.js and npm installed | ||
| - Python with DepthAI SDK installed |
There was a problem hiding this comment.
Not DepthAi SDK just Depthai
Depthai SDK is a deprecated package we no longer use
custom-frontend/GETTING_STARTED.md
Outdated
| ### Install dependencies | ||
| - Node.js and npm installed | ||
| - Python with DepthAI SDK installed | ||
| - An OAK device (for testing) |
custom-frontend/GETTING_STARTED.md
Outdated
| # Quick Start | ||
|
|
||
| If you want to skip setup and start modifying a working app immediately, | ||
| clone the [`raw-stream`](./raw-stream) example. |
There was a problem hiding this comment.
You can clone the oak-examples repo, but not just the raw-stream example
custom-frontend/GETTING_STARTED.md
Outdated
| ### Configure PandaCSS | ||
|
|
||
| Shared Luxonis UI components are built on |
There was a problem hiding this comment.
I don't understand this. The shared luxonis UI components is what? is it @luxonis/depthai-viewer-common?
Are you trying to say that @luxonis/depthai-viewer-common is internally dependent on @luxonis/common-fe-components which has the pandaCSS dependency?
There was a problem hiding this comment.
Yes, that is how it is. I will try to make text easier to understand
custom-frontend/GETTING_STARTED.md
Outdated
| For additional customization options, explore the `Streams` component props. | ||
|
|
||
| ### Sending Messages to Backend |
There was a problem hiding this comment.
This is not accurate. The services provide bidirectional BE <-> FE communication.
Purpose
Update of Getting Started file to correctly reflect the current custom frontend setup.
Specification
The Getting Started file has been rewritten to align with the current frontend architecture, and setup steps. Outdated links and instructions were removed or corrected. Also Raw-Stream FE example was updated to use recent version of the "@luxonis/depthai-viewer-common".
Dependencies & Potential Impact
Did change FE of the Raw-Stream example
Deployment Plan
Can be merged without any changes.
Testing & Validation
Raw-Stream example was tested manually in both standalone and peripheral modes